home *** CD-ROM | disk | FTP | other *** search
/ Hottest 6 / Hottest 6 (1996)(PDSoft)[!].iso / software / fredfish / 1050.lha / Programs / Binary_dt / doc / binary_dtc.doc < prev   
Encoding:
Text File  |  1994-12-28  |  2.9 KB  |  87 lines
  1.  
  2.  
  3. TABLE OF CONTENTS
  4.  
  5. binary.datatype/binary.datatype
  6.  
  7.  
  8. binary.datatype/binary.datatype                binary.datatype/binary.datatype
  9.  
  10.     NAME
  11.         binary.datatype -- data type for any binary file
  12.  
  13.     FUNCTION
  14.         The binary data type, a base-class of all binary data, is used to
  15.         load any binary file and displays the contents of the file in hex
  16.         format.
  17.  
  18.     PREFS
  19.         The data type tries to load the prefs file "ENV:binary.prefs" on
  20.         each OM_NEW method to set up the attributes !
  21.         This prefs file has the following format :
  22.         line = NOASCII     |  - set BDTA_ShowASCII to FALSE
  23.                NOWRAP      |  - set BDTA_DisplayWrap to FALSE
  24.                NONE        |  - set BDTA_DisplayHex to BDTDH_NONE
  25.                BYTE        |  - set BDTA_DisplayHex to BDTDH_BYTE
  26.                WORD        |  - set BDTA_DisplayHex to BDTDH_WORD
  27.                LONG        |  - set BDTA_DisplayHex to BDTDH_LONG
  28.                BYTES <bpl>    - set BDTA_BytesPerLine to <bpl> bytes
  29.  
  30.     METHODS
  31.         OM_NEW -- Create a new text object from a binary file in hex mode.
  32.  
  33.         OM_DISPOSE -- dispose a object
  34.  
  35.         OM_GET -- get a attribute of the object
  36.  
  37.         OM_SET -- set attributes of the object
  38.  
  39.         OM_UPDATE -- update some attributes of the object
  40.  
  41.         GM_LAYOUT -- Method to layout the hex text
  42.  
  43.         GM_RENDER -- draw the object
  44.  
  45.         DTM_WRITE -- DTWM_RAW mode is supported
  46.  
  47.     TAGS
  48.         BDTA_Buffer -- (UBYTE *) pointer to the buffer, which should be
  49.             displayed.
  50.             Applicability is (ISG).
  51.  
  52.         BDTA_BufferLen -- (ULONG) length of the buffer supplied with
  53.             BDTA_Buffer tag. This must be given if the buffer tag is
  54.             specified.
  55.             Applicability is (ISG).
  56.  
  57.         BDTA_BytesPerLine -- (UWORD) number of bytes per line.
  58.             If BDTA_DisplayHex is BDTDH_WORD it must be a multiply of 2,
  59.             if it is BDTDH_LONG it must be a multiply of 4 !
  60.             Default is 32.
  61.             Applicability is (ISGNU).
  62.  
  63.         BDTA_DisplayHex -- (UWORD) type of the display. The following types
  64.             are supported : BDTDH_NONE  - displays no hex values
  65.                             BDTDH_BYTE  - displays each byte in hex ( 8 bit)
  66.                             BDTDH_WORD  - displays each word in hex (16 bit)
  67.                             BDTDH_LONG  - displays each long in hex (32 bit)
  68.             Default is BDTDH_LONG.
  69.             Applicability is (ISGNU).
  70.  
  71.         BDTA_ShowASCII -- (BOOL) display at the end of the line the
  72.             appropriate ASCII string !
  73.             Default is TRUE.
  74.             Applicability is (ISGNU).
  75.  
  76.         BDTA_DisplayWrap -- (BOOL) the BDTA_BytesPerLine are ignored and the
  77.             byte number is retrieved from the object width !
  78.             Default is TRUE.
  79.             Applicability is (ISGNU).
  80.  
  81.     BUGS
  82.         At the moment proportional fonts can't be handled.
  83.  
  84.     SEE ALSO
  85.         datatypesclass (where ?)
  86.  
  87.